Vcenter Topology Nodes Summary

The Vcenter Topology Nodes Summary schema contains commonly used information of vCenter or Platform Services Controller node.

This schema was added in vSphere API 6.7.2.

JSON Example

{
    "node": "string",
    "type": "string",
    "replication_partners": [
        "string"
    ],
    "client_affinity": "string"
}

string

node

Required

Identifier for the vCenter or Platform Services Controller node. Identifier can be either IP address or DNS resolvable name of the node.

This property was added in vSphere API 6.7.2.

When clients pass a value of this schema as a parameter, the property must be an identifier for the resource type: com.vmware.vcenter.VCenter.name. When operations return a value of this schema as a response, the property will be an identifier for the resource type: com.vmware.vcenter.VCenter.name.

string

type

Required

Appliance type of the node.

For more information see: Vcenter Topology Nodes ApplianceType.

This property was added in vSphere API 6.7.2.

array of string

replication_partners

Optional

List of replication partners' node identifiers. Identifiers can be either IP address or DNS resolvable name of the partner node.

This property was added in vSphere API 6.7.2.

This property is optional and it is only relevant when the value of type is one of Vcenter Topology Nodes ApplianceType.VCSA_EMBEDDED or Vcenter Topology Nodes ApplianceType.PSC_EXTERNAL.

When clients pass a value of this schema as a parameter, the property must contain identifiers for the resource type: com.vmware.vcenter.VCenter.name. When operations return a value of this schema as a response, the property will contain identifiers for the resource type: com.vmware.vcenter.VCenter.name.

string

client_affinity

Optional

Identifier of the affinitized Platform Services Controller node. Identifier can be either IP address or DNS resolvable name of the affinitized node.

This property was added in vSphere API 6.7.2.

This property is optional and it is only relevant when the value of type is Vcenter Topology Nodes ApplianceType.VCSA_EXTERNAL.